SureTax Returns API

GET Form Instances

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint retrieves comprehensive details regarding a specific generated form instance. It provides clients with essential information such as form ID, name, format, size, availability of logs, visualization support, and current status.

OperationId: GET Form Instances

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/FormInstances

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

FormsResponse

OVERVIEWEXAMPLE

Overview

Represents the overall response object containing form instances data.

FormsResponse

Display Name	Field Name	Field Type
Data	data	FormInstancesResponse

FormInstancesResponse

Display Name	Field Name	Field Type
Form Instances	formInstances	array[FormInstance]

FormInstance

Display Name	Field Name	Field Type
Id	id	string
Name	name	string
Format	format	string
Size	size	string
Is Log Available	isLogAvailable	string
Is Change Log Available	isChangeLogAvailable	string
Visualization	visualization	string
Status	status	string

Example Response

The following is an example response you can expect for this operation

{
  "data": {
    "formInstances": [
      {
        "id": "c5969fec-d993-4e81-aadc-5c5d0187862c",
        "name": "Sales Tax Return",
        "format": "txt",
        "size": "3027",
        "isLogAvailable": false,
        "isChangeLogAvailable": false,
        "visualization": "2",
        "status": "GEN"
      }
    ]
  }
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	The API response contains a list of form instances with their details. Success Response - 200 OK. The API will respond with a list of form instances and their information.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. The API will respond with an error if there is an issue with the request parameters.
401	Unauthorized request. The API will respond with an error if the user is not authenticated.
500	Internal server error. The API will respond with an error if there is an unexpected server issue.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstances

Add Request Headers: